WIP: Scriptv2 docs #614
Draft
WIP: Scriptv2 docs #614
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
macobo
force-pushed
the
scriptv2-docs
branch
2 times, most recently
from
79dc0df to
61862b8
Compare
ukutaht
reviewed
Jul 3, 2025
ukutaht
reviewed
Jul 3, 2025
apata
reviewed
Aug 6, 2025
apata
reviewed
Aug 6, 2025
macobo
force-pushed
the
scriptv2-docs
branch
4 times, most recently
from
60061c4 to
ef8d8f7
Compare
apata
reviewed
Sep 1, 2025
| @@ -24,7 +39,7 @@ proxy_cache_path /var/run/nginx-cache/jscache levels=1:2 keys_zone=jscache:100m | |||
| server { | |||
|
|
|||
| resolver 9.9.9.9; # Use quad9 DNS resolver. Remove this line if you've already configured a DNS resolver. | |||
| set $plausible_script_url https://plausible.io/js/script.js; # Change this if you use a different variant of the script | |||
| set $plausible_script_url https://plausible.io/js/pa-XXXXX.js; # Change this to path from step 1 | |||
There was a problem hiding this comment.
TODO: maybe remove caching instructions
apata
reviewed
Sep 1, 2025
Comment on lines
+14
to
+22
| function queryStrippedUrl() { | ||
| return location.href.split('?')[0] | ||
| } | ||
|
|
||
| ```html | ||
| <!-- define the `plausible` function to manually trigger events --> | ||
| <script>window.plausible = window.plausible || function() { (window.plausible.q = window.plausible.q || []).push(arguments) }</script> | ||
| ``` | ||
|
|
||
| Once that's done, you can create another script in which you will trigger your pageview event. This is where you can override the URL property sent to Plausible and prevent the tracking of UTM tags. To do so, add the following snippet: | ||
|
|
||
| ```html | ||
| <!-- trigger pageview --> | ||
| <script> | ||
| function queryStrippedUrl() { | ||
| return location.href.split('?')[0] | ||
| } | ||
| plausible('pageview', { u: queryStrippedURL() }) | ||
| </script> | ||
| ``` | ||
| function transformRequest(payload) { | ||
| // Sets url for the event manually | ||
| payload.u = queryStrippedUrl() | ||
| return payload | ||
| } |
There was a problem hiding this comment.
suggestion: Because location may have changed between event collection and the time queryStrippedUrl is called, I suggest we rely on the url in the payload:
function transformRequest(payload) {
var parts = payload.u.split('?')
var urlWithoutQuery = parts.shift()
if (payload.h) {
var fragment = parts.join('?').split('#')[1]
urlWithoutQuery = typeof fragment === 'string'
? urlWithoutQuery + '#' + fragment
: urlWithoutQuery
}
payload.u = urlWithoutQuery
return payload
}
apata
reviewed
Sep 1, 2025
Comment on lines
-133
to
+126
| <script>window.plausible = window.plausible || function() { (window.plausible.q = window.plausible.q || []).push(arguments) }</script> | ||
| <script> | ||
| ```javascript | ||
| function redactedUrl() { | ||
| var url = window.location.href; | ||
| // Replace every all-numeric sequences located between two slashes by "_ID_" | ||
| var redactedUrl = url.replace(/\/\d+\//g, "/_ID_/"); | ||
| // Send the pageview event to Plausible | ||
| plausible('pageview', { u: redactedUrl + window.location.search}); | ||
| </script> | ||
| return url.replace(/\/\d+\//g, "/_ID_/"); | ||
| } | ||
|
|
||
| function transformRequest(payload) { | ||
| payload.u = redactedUrl() + window.location.search | ||
| return payload | ||
| } | ||
|
|
||
| // At the end, update plausible.init call | ||
| plausible.init({ | ||
| transformRequest: transformRequest | ||
| }) |
There was a problem hiding this comment.
nitpick: This may use stale location, giving inaccurate pageviews, and it also breaks if hashBasedRouting is true. I think we should tune this a bit, along the lines of https://github.com/plausible/docs/pull/614/files#r2314455677
apata
reviewed
Sep 1, 2025
Comment on lines
+85
to
+88
| if (canonicalMeta) { | ||
| payload.u = canonicalMeta.href + window.location.search | ||
| } | ||
| return payload |
There was a problem hiding this comment.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What's new:
What's updated:
TBD: